/*
 * Copyright (c) 2001, 2002 Boris Pruessmann and others. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Common Public License v0.5 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/cpl-v05.html
 * 
 * Contributors: Boris Pruessmann - Initial implementation.
 */
package net.sourceforge.perforce.core.api;

/**
 * This interface describes the result of a 'p4 counters' command.
 * 
 * @version $Revision: 488 $
 * @author <a href="mailto:bpruessmann@users.sourceforge.net">Boris
 *         Pruessmann</a>
 */
public interface ICountersResult {
  //----------------------------------------------------------------------------
  // ------- Constants

  /** the current change list number */
  final String CHANGE = "change"; //$NON-NLS-1$

  /** the current job number */
  final String JOB = "job"; //$NON-NLS-1$

  /** the current journal number */
  final String JOURNAL = "journal"; //$NON-NLS-1$

  /** the server database upgrade level */
  final String UPGRADE = "upgrade"; //$NON-NLS-1$

  //----------------------------------------------------------------------------
  // --------- Methods

  /**
   * Returns the value stored for the specified counter.
   * 
   * @param counterName the name of the counter.
   * @return the value of the counter.
   */
  Integer getCounterValue(String counterName);
}
